Release 10.1A: OpenEdge Getting Started:
WebSpeed Essentials

WTBMAN utility

Use the WTBMAN utility to control the operation of a configured WebSpeed Transaction Server. The utility allows you to start a Transaction Server, query its status, start and stop additional WebSpeed Agents, trim by a certain number of agents, and shut down the Transaction Server. Table A–4 shows the WTBMAN utility’s syntax.

Table A–4: WTBMAN synatax

Operating system	Syntax
UNIX Windows	wtbman { { -name transaction-server-name { -kill | -start | -stop | -query | -addagents number-to-start | -trimagents number-to-trim } [ -host host-name -user user-name | -user user-name ] [ -port port-number ] } | -help }

Parameters

-name transaction-server-name

Specifies the name of a Transaction Server.

-kill

Stops and removes the transactionserver from memory, no matter what it is doing.

-start

Starts the Transaction Server.

-stop

Stops the Transaction Server.

-query

Queries the Transaction Server for its status.

-addagents number-to-start

Specifies the number of additional agents to start.

-trimagents number-to-trim

Specifies the number of additional agents to trim.

-host host-name

Specifies the name of the machine where the AdminServer is running. If a host name is not specified, it defaults to the local host name.

-user user-name

Specifies a user name and prompts for a password when logging into a remote machine. A user name and password are required only when you use the -host parameter and specify a remote host name. If you specify a remote host name with the -host parameter but do not specify a user name with the -user parameter, you receive a prompt for a user name and password.

-port port-number

Specifies the port number of the machine on which the AdminServer controlling the WebSpeed Transaction Server is running. If a port number is not specified, it defaults to 20931.

-help

Displays command-line help.

Examples

Table A–5 shows several examples that use the wtbman command. Assume that the Transaction Server name is wsbroker1; the user name is tom; and the AdminServer is on the remote host finance at port 9999.

Table A–5: WTBMAN command examples 

Task	Command
Start a local Transaction Server.	wtbman -name wsbroker1 -start
Start a remote Transaction Server.1	wtbman -name wsbroker1 -host finance -port 9999 -user tom -start
Query a local Transaction Server.	wtbman -name wsbroker1 -query
Query a remote Transaction Server.1	wtbman -name wsbroker1 -host finance -port 9999 -user tom -query
Add agents (for example, 2) to a local Transaction Server.	wtbman -name wsbroker1 -addagents 2
Add agents (for example, 2) to a remote Transaction Server.1	wtbman -name wsbroker1 -host finance -port 9999 -user tom -addagents 2
Trim agents (for example, 3) from a local Transaction Server.	wtbman -name wsbroker1 -trimagents 3
Trim agents (for example, 3) from a remote Transaction Server.1	wtbman -name wsbroker1 -host finance -port 9999 -user tom -trimagents 3
Stop a local Transaction Server.	wtbman -name wsbroker1 -stop
Stop a remote Transaction Server.1	wtbman -name wsbroker1 -host finance -port 9999 -user tom -stop

1Prompts for a password.

Notes: When you specify a user name with the -user parameter, Windows supports three different formats:

A user name as a simple text string, such as mary, implies a local user whose user account is defined on the local server, which is the same machine that runs the AdminServer.

A user name as an explicit local user name, in which the user account is defined on the same machine that runs the AdminServer except the user name explicitly references the local machine domain, for example .\mary.

A user name as a user account on a specific domain. The general format is Domain\User, in which the User is a valid user account defined within the domain, and the Domain is any valid server, including the one where the AdminServer is running